home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / u_man / cat1 / explain.z / explain
Text File  |  1998-10-20  |  17KB  |  305 lines
  1. EXPLAIN(1)                                            Last changed: 7-21-97
  2.  
  3.  
  4. NNAAMMEE
  5.      eexxppllaaiinn - Displays the explanation for an error message
  6.  
  7. SSYYNNOOPPSSIISS
  8.      eexxppllaaiinn _m_s_g_i_d
  9.  
  10. IIMMPPLLEEMMEENNTTAATTIIOONN
  11.      UNICOS systems
  12.  
  13.      IRIX systems
  14.  
  15. DDEESSCCRRIIPPTTIIOONN
  16.      The eexxppllaaiinn utility retrieves and outputs a message explanation from
  17.      an online explanation catalog.  If the output device is a terminal,
  18.      the output of eexxppllaaiinn is piped through the pager specified in the
  19.      PPAAGGEERR variable.  If PPAAGGEERR is not specified, the default pager mmoorree --ss
  20.      is used.  If the output device is not a terminal, the output of
  21.      eexxppllaaiinn is sent to the standard output device (ssttddoouutt).
  22.  
  23.      The eexxppllaaiinn utility requires the following argument:
  24.  
  25.      _m_s_g_i_d  Specifies the message ID string associated with a message that
  26.             appears when an error message is output.  This string consists
  27.             of the product group code and the message number.  The product
  28.             group code (_g_r_o_u_p) is a string that identifies the product
  29.             issuing the message.  The message number (_m_s_g#) specifies which
  30.             message within the product you have received.  Enter the
  31.             message ID as an argument to eexxppllaaiinn in the form _g_r_o_u_p_m_s_g# or
  32.             in the form _g_r_o_u_p-_m_s_g#.  If the group code ends in one or more
  33.             digits (for example, ccff9900), you must use the form that includes
  34.             the dash (--).
  35.  
  36.    RReeccooggnniizzeedd GGrroouupp CCooddeess
  37.      The following tables show the products and group codes that have
  38.      message and explanation catalogs on UNICOS systems and on IRIX
  39.      systems.  The first column lists the group code (needed to look up the
  40.      explanations for messages); the second column gives the complete name
  41.      of the software product or products associated with the group code;
  42.      the third column lists the publication number in which explanations
  43.      for messages in that group code can be found.
  44.  
  45.  
  46.                                UNICOS group codes
  47.      ---------------------------------------------------------------
  48.      Group Code  Software Product                       Publication
  49.      ---------------------------------------------------------------
  50.      aapppprreennttiiccee  MPP Apprentice tool                    Online only
  51.      aass          CAL assembler                          SR-3108
  52.      aassmm         Cray Assembler for MPP (CAM)           Online only
  53.      aattcchhoopp      aattcchhoopp(1) performance tool             Online only
  54.      aatteexxppeerrtt    aatteexxppeerrtt(1) performance tool           Online only
  55.      bbuuiillddddeeffss   bbuuiillddddeeffss(1) command of the UNICOS     Online only
  56.                  glossary
  57.      cccc          Cray Standard C compiler               Online only
  58.      ccff9900        CF90 Fortran language                  Online only
  59.      cclldd         Loader for CRAY T3E systems            Online only
  60.      ccmmdd         UNICOS utilities that are compliant    Online only
  61.                  with XPG4
  62.      ddbbgg         ccddbbxx(1), ddeebbuugg(1), ssyymmddeebbuugg(3F), and   Online only
  63.                  ssyymmdduummpp(3F) debugging commands
  64.      ddeeffiinnee      ddeeffiinnee(1) command of the UNICOS        Online only
  65.                  glossary
  66.      ddeepplliibb      ddeepplliibb(1) command                      Online only
  67.      ddff          ddff(1) utility                          Online only
  68.      ddmm          Data Migration Facility                SG-2135
  69.      dduu          dduu(1) utility                          Online only
  70.      eexx          eexx(1) and vvii(1) utilities              Online only
  71.      fflloowwvv       fflloowwvviieeww(1) performance tool           Online only
  72.      ffmmpp         ffmmpp(1) Fortran vectorization           SR-3771
  73.                  translator
  74.      ffpppp         ffpppp(1) Fortran vectorization analyzer  SR-3771
  75.      ffssqquuoottaa     File system quota feature              Online only
  76.      hhppmm         hhppmm(1) performance tool                Online only
  77.      hhppmmaallll      hhppmmaallll(8) performance tool             Online only
  78.      hhppmmfflloopp     hhppmmfflloopp(8) performance tool            Online only
  79.      jjtt          jjtt(1) performance tool                 Online only
  80.      jjuummppvv       jjuummppvviieeww(1) performance tool           Online only
  81.      llddrr         sseeggllddrr(1) and lldd(1) loader commands    SR-0066
  82.      lliibb         Fortran and I/O libraries              Online only
  83.      lliibbmm        Mathematical libraries                 SG-2138
  84.      lliibbpp        Pascal library                         Online only
  85.      llpprrooff       lliibbpprrooff library                        Online only
  86.      llttrraaccee      Jumptrace library                      Online only
  87.      mmppppllddrr      Loader for CRAY T3D systems            Online only
  88.      mmttdduummpp      mmttdduummpp(1) performance tool             Online only
  89.      nnqqss         Network Queuing System                 Online only
  90.      ppeerrff        lliibbppeerrff library                        Online only
  91.      ppeerrffddmmpp     ppeerrffddmmpp(1) performance tool            Online only
  92.      ppeerrffvv       ppeerrffvviieeww(1) performance tool           Online only
  93.      pprroocc        pprrooccssttaatt(1) performance tool           Online only
  94.      pprrooccvv       pprrooccvviieeww(1) performance tool           Online only
  95.      pprrooff        pprrooff(1) performance tool               Online only
  96.      pprrooffvv       pprrooffvviieeww(1) performance tool           Online only
  97.      ppss          ppss(1) utility                          Online only
  98.      sshh          Standard shell                         Online only
  99.      ssyyss         UNICOS system error list               SR-2012
  100.                  (ssyysseerrrrlliisstt[])
  101.      ssyysslloogg      System message logger (nneewwssyyss(8) and   Online only
  102.                  ssyyssllooggdd(8))
  103.      ttaallkk        ttaallkk(1B) utility                       Online only
  104.      uurrmm         Unified Resource Manager               Online only
  105.      uussmm         UNICOS Source Manager (USM)            SG-2097
  106.      ---------------------------------------------------------------
  107.  
  108.  
  109.                                 IRIX group codes
  110.      ---------------------------------------------------------------
  111.      Group Code  Software Product                       Publication
  112.      ---------------------------------------------------------------
  113.      ccff9900        ff9900 version 7.2                        Online only
  114.      lliibb         Fortran 90 library version 2.0, and    Online only
  115.                  lliibbffffiioo
  116.      mmssggssyyss      eexxppllaaiinn(1) and ccaatteerrrr(1) utilities     Online only
  117.      ---------------------------------------------------------------
  118.  
  119.    LLooccaattiioonn ooff EExxppllaannaattiioonn CCaattaallooggss
  120.      To find the explanation for the message, eexxppllaaiinn searches the path
  121.      specified in the NNLLSSPPAATTHH environment variable for the _g_r_o_u_p..eexxpp file.
  122.      The value of the NNLLSSPPAATTHH variable depends on the LLAANNGG environment
  123.      variable or the LLCC__MMEESSSSAAGGEESS category.  If eexxppllaaiinn cannot access an
  124.      existing explanation catalog, check the value of the NNLLSSPPAATTHH
  125.      environment variable and either the LLAANNGG environment variable or the
  126.      LLCC__MMEESSSSAAGGEESS category to ensure that the path name of the catalog is in
  127.      the message system search path.
  128.  
  129.      On UNICOS systems, you can use the wwhhiicchhccaatt(1) utility to determine
  130.      which catalog is being accessed by eexxppllaaiinn.  For more information, see
  131.      wwhhiicchhccaatt(1).
  132.  
  133.      On UNICOS systems, see the ccaattooppeenn(3C) man page for a description of
  134.      the NNLLSSPPAATTHH, LLAANNGG, and LLCC__MMEESSSSAAGGEESS components.
  135.  
  136.      On IRIX systems, see eennvviirroonn(5) for a description of the NNLLSSPPAATTHH,
  137.      LLAANNGG, and LLLLCC__MMEESSSSAAGGEESS components.
  138.  
  139.    MMeessssaaggee FFoorrmmaatt VVaarriiaabblleess
  140.      If _m_s_g_i_d does not appear with the error message or if you want to
  141.      change the format of the messages you receive, you can modify your
  142.      MMSSGG__FFOORRMMAATT and CCMMDDMMSSGG__FFOORRMMAATT environment variables.  Both variables
  143.      can be set to define the fields and the order of the fields to be
  144.      included in message output.
  145.  
  146.      The MMSSGG__FFOORRMMAATT variable controls the format in which you receive error
  147.      messages from programs that use the message formatting function
  148.      ccaattmmssggffmmtt(3C).  On UNICOS systems, these are most messages in group
  149.      codes other than ccmmdd.  On IRIX systems, these are most messages in
  150.      group codes other than mmssggssyyss.
  151.  
  152.      On UNICOS systems, the CCMMDDMMSSGG__FFOORRMMAATT variable controls the format in
  153.      which you receive error messages issued by system utilities that are
  154.      included in the XPG4 standard.  These are messages in the ccmmdd group
  155.      code.  A separate environment variable is provided to control message
  156.      output from these utilities, because it is often desirable to capture
  157.      and process this output through a script or program; limiting the
  158.      output to one line makes this easier.  The default format (shown
  159.      below) for non-utility messages outputs at least two lines.  The
  160.      CCMMDDMMSSGG__FFOORRMMAATT variable exists to provide a one-line default format for
  161.      utility messages.
  162.  
  163.      On IRIX systems, the eexxppllaaiinn and ccaatteerrrr utilities use either
  164.      CCMMDDMMSSGG__FFOORRMMAATT or MMSSGG__FFOORRMMAATT variables; however, CCMMDDMMSSGG__FFOORRMMAATT is used
  165.      before MMSSGG__FFOORRMMAATT.
  166.  
  167.    MMeessssaaggee FFoorrmmaatt SSyynnttaaxx
  168.      Valid fields for MMSSGG__FFOORRMMAATT and CCMMDDMMSSGG__FFOORRMMAATT are as follows:
  169.  
  170.      %%GG   Group code
  171.  
  172.      %%NN   Message number
  173.  
  174.      %%CC   Command name
  175.  
  176.      %%SS   Severity level
  177.  
  178.      %%PP   Position of the error
  179.  
  180.      %%MM   Message text
  181.  
  182.      %%DD   Debugging information
  183.  
  184.      %%TT   Time stamp
  185.  
  186.      If one of the %% fields is not present in the contents of MMSSGG__FFOORRMMAATT or
  187.      CCMMDDMMSSGG__FFOORRMMAATT, the corresponding message field is not printed.
  188.  
  189.      The default message format is produced by the following assumed
  190.      MMSSGG__FFOORRMMAATT contents:
  191.  
  192.           %G-%N  %C: %S %P\n  %M\n
  193.  
  194.      For messages issued by UNICOS utilities, and by the IRIX utilities
  195.      eexxppllaaiinn(1) and ccaatteerrrr(1), the default message format is produced by
  196.      the following assumed CCMMDDMMSSGG__FFOORRMMAATT contents:
  197.  
  198.           %G-%N: %C %M\n
  199.  
  200.      Messages issued from the ccmmdd group code determine their format
  201.      according to the following precedence:
  202.  
  203.      1. Content of CCMMDDMMSSGG__FFOORRMMAATT variable, if it exists
  204.  
  205.      2. Content of MMSSGG__FFOORRMMAATT variable, if it exists
  206.  
  207.      3. Default message format for utilities
  208.  
  209.      The format of the time stamp (%%TT) is equivalent to that produced by
  210.      the ccffttiimmee(3C) function and can be overridden by the CCFFTTIIMMEE
  211.      environment variable.  For details about time stamp formats, see the
  212.      ssttrrffttiimmee(3C) man page, which documents the ccffttiimmee function.
  213.  
  214.      The Standard C pprriinnttff escape sequences also can be embedded in the
  215.      contents of MMSSGG__FFOORRMMAATT.  The following table lists special characters
  216.      that can be embedded.
  217.  
  218.      --------------------------------
  219.      Description      Symbol  Sequence
  220.      --------------------------------
  221.      New-line         NL      \\nn
  222.      character        (LF)
  223.      Horizontal tab   HT      \\tt
  224.      Vertical tab     VT      \\vv
  225.      Backspace        BS      \\bb
  226.      Carriage return  CR      \\rr
  227.      Form feed        FF      \\ff
  228.      Audible alert    BEL     \\aa
  229.      Backslash        \       \\\\
  230.      Question mark    ?       \\??
  231.      Single           '       \\''
  232.      quotation mark
  233.      Double           "       \\""
  234.      quotation mark
  235.      Octal number     _o_o_o     \\_o_o_o
  236.      Hexadecimal      _h_h      \\xx_h_h
  237.      number
  238.      --------------------------------
  239.  
  240.      The escape \_o_o_o consists of the backslash followed by 1, 2, or 3 octal
  241.      digits, which are taken to specify the value of the desired character.
  242.      A common example of this construction is \\00, which specifies the null
  243.      character.  The escape \\xx_h_h consists of the backslash, followed by xx,
  244.      followed by hexadecimal digits, which are taken to specify the value
  245.      of the desired character.  There is no limit on the number of digits,
  246.      but the behavior is undefined if the resulting character value exceeds
  247.      that of the largest character.
  248.  
  249.      Any characters other than those listed in this table are passed
  250.      through without the backslash, (for example, \\qq produces qq).
  251.  
  252. NNOOTTEESS
  253.      On UNICOS systems, if this utility is installed with a privilege
  254.      assignment list (PAL), a user with one of the following active
  255.      categories is allowed to perform the actions shown:
  256.  
  257.      AAccttiivvee CCaatteeggoorryy     AAccttiioonn
  258.  
  259.      ssyysstteemm, sseeccaaddmm      In a privileged administrator shell environment,
  260.                          allowed to write shell-redirected output to any
  261.                          file.
  262.  
  263.      ssyyssaaddmm              Shell-redirected output is subject to security
  264.                          label restrictions.
  265.  
  266.      If the PPRRIIVV__SSUU configuration option is enabled, the super user can
  267.      write shell-redirected output to any file.
  268.  
  269. SSEEEE AALLSSOO
  270.    UUNNIICCOOSS ssyysstteemmss
  271.      ccaatteerrrr(1), ccaattxxtt(1), ggeennccaatt(1), wwhhiicchhccaatt(1)
  272.  
  273.      ccaattggeettmmssgg(3C), ccaattggeettss(3C), ccaattmmssggffmmtt(3C), ccaattooppeenn(3C), ssttrrffttiimmee(3C)
  274.      in the _U_N_I_C_O_S _S_y_s_t_e_m _L_i_b_r_a_r_i_e_s _R_e_f_e_r_e_n_c_e _M_a_n_u_a_l, publication SR-2080
  275.  
  276.      nnll__ttyyppeess(5), mmssgg(7D) in the _U_N_I_C_O_S _F_i_l_e _F_o_r_m_a_t_s _a_n_d _S_p_e_c_i_a_l _F_i_l_e_s
  277.      _R_e_f_e_r_e_n_c_e _M_a_n_u_a_l, publication SR-2014
  278.  
  279.    IIRRIIXX ssyysstteemmss
  280.      ccaatteerrrr(1), ggeennccaatt(1)
  281.  
  282.      ccaattggeettmmssgg(3C), ccaattmmssggffmmtt(3C)
  283.  
  284.      mmssgg(7D)
  285.  
  286.    CCrraayy RReesseeaarrcchh ppuubblliiccaattiioonnss
  287.      _U_N_I_C_O_S _M_e_s_s_a_g_e _S_y_s_t_e_m _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_e, publication SG-2121
  288.  
  289.      _S_e_g_m_e_n_t _L_o_a_d_e_r (_S_E_G_L_D_R) _a_n_d _l_d _R_e_f_e_r_e_n_c_e _M_a_n_u_a_l, publication SR-0066
  290.  
  291.      _U_N_I_C_O_S _S_y_s_t_e_m _C_a_l_l_s _R_e_f_e_r_e_n_c_e _M_a_n_u_a_l, publication SR-2012
  292.  
  293.      _U_N_I_C_O_S _S_o_u_r_c_e _M_a_n_a_g_e_r (_U_S_M) _U_s_e_r'_s _G_u_i_d_e, publication SG-2097
  294.  
  295.      _C_r_a_y _D_a_t_a _M_i_g_r_a_t_i_o_n _F_a_c_i_l_i_t_y (_D_M_F) _A_d_m_i_n_i_s_t_r_a_t_o_r'_s _G_u_i_d_e, publication
  296.      SG-2135
  297.  
  298.      _I_n_t_r_i_n_s_i_c _P_r_o_c_e_d_u_r_e_s _R_e_f_e_r_e_n_c_e _M_a_n_u_a_l, publication SR-2138
  299.  
  300.      _C_r_a_y _A_s_s_e_m_b_l_y _L_a_n_g_u_a_g_e (_C_A_L) _f_o_r _C_r_a_y _P_V_P _S_y_s_t_e_m_s _R_e_f_e_r_e_n_c_e _M_a_n_u_a_l,
  301.      publication SR-3108
  302.  
  303.      _U_N_I_C_O_S _U_s_e_r _C_o_m_m_a_n_d_s _R_e_f_e_r_e_n_c_e _M_a_n_u_a_l, publication SR-2011, for the
  304.      printed version of this man page.
  305.